/*
 * ===========================================
 * Java Pdf Extraction Decoding Access Library
 * ===========================================
 *
 * Project Info:  http://www.idrsolutions.com
 * Help section for developers at http://www.idrsolutions.com/java-pdf-library-support/
 *
 * (C) Copyright 1997-2013, IDRsolutions and Contributors.
 *
 * 	This file is part of JPedal
 *
     This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA


 *
 * ---------------
 * AcroRenderer.java
 * ---------------
 */
package org.jpedal.objects.acroforms.rendering;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.jpedal.PdfDecoder;
import org.jpedal.exception.PdfException;
import org.jpedal.io.PdfObjectReader;
import org.jpedal.objects.Javascript;
import org.jpedal.objects.PdfPageData;
import org.jpedal.objects.acroforms.actions.ActionHandler;
import org.jpedal.objects.acroforms.creation.FormFactory;
import org.jpedal.objects.acroforms.formData.GUIData;
import org.jpedal.objects.raw.PdfArrayIterator;
import org.jpedal.objects.raw.PdfObject;
import org.jpedal.parser.PdfStreamDecoder;
import org.w3c.dom.Node;

/**
 * sets up the display and called to draw objects as needed
 */
public interface AcroRenderer {

	/**
	 * reset Handler
	 */
	public void resetHandler(Object userActionHandler, PdfDecoder decode_pdf, int type);

	/**
	 * called before decode page by clearscreen to remove components -user should not call
	 */
	public void removeDisplayComponentsFromScreen();

	/**
	 * called when new file opened - different purpose for Annots and form
	 */
	public void openFile(int pageCount);

	/**
	 * called before decode page by clearscreen to remove components -user should not call
	 */
	public void resetFormData(int insetW, int insetH, PdfPageData pageData, PdfObjectReader curentPdfFile, PdfObject acroObj);

	public void resetAnnotData(int insetW, int insetH, PdfPageData pageData, int page, PdfObjectReader curentPdfFile, byte[][] currentAnnotList);

	/**
	 * create display - called inside PDF decoder once page decoded -user should not call
	 */
	public void createDisplayComponentsForPage(int page, PdfStreamDecoder current);

	/**
	 * return the component associated with this objectName (returns null if no match). Names are case-sensitive. Please also see method
	 * getComponentNameList(int pageNumber)
	 */
	public Object[] getComponentsByName(String objectName);

	/**
	 * return a List containing the names of forms on a specific page which has been decoded.
	 * 
	 * @throws PdfException
	 *             An exception is thrown if page not yet decoded
	 */
	public List getComponentNameList(int pageNumber) throws PdfException;

	/**
	 * return a List containing the names of forms on a specific page which has been decoded.
	 * 
	 * @throws PdfException
	 *             An exception is thrown if page not yet decoded
	 */
	public List getComponentNameList() throws PdfException;

	/**
	 * setup object which creates all GUI objects
	 */
	public void setFormFactory(FormFactory newFormFactory);

	/**
	 * used to draw forms from multiple pages
	 */
	public void displayComponentsOnscreen(int startPage, int endPage);

	/**
	 * removes the forms on the specified pages from the panel
	 */
	// public void removePageRangeFromDisplay(int i, int j, PdfPanel decoder);

	Javascript getJavaScriptObject();

	/** allow user to access Signature objects - null if none */
	public Iterator getSignatureObjects();

	// public Map getSignatureObject(String ref);

	public GUIData getCompData();

	public Object[] getFormDataAsObject(String formName);

	public ActionHandler getActionHandler();

	FormFactory getFormFactory();

	public Map getRawFormData();

	public boolean ignoreForms();

	public void setIgnoreForms(boolean flag);

	public void dispose();

	public PdfArrayIterator getAnnotsOnPage(int p);

	/******** METHODS FOR JAVASCRIPT ACCESSING *************/

	/** JS check all forms to see if any have been updated and if so update them */
	public void updateChangedForms();

	/** JS return the first field by the given name */
	public Object getField(String name);

	/** JS returns an array of names, for which this parent object is extended into. */
	public String[] getChildNames(String name);

	/** JS resets all the fields within this form. */
	public void resetForm();

	/**
	 * JS resets the fields within this form.
	 * 
	 * @param aFields
	 *            - defines which fields to reset, or all fields if null.
	 */
	public void resetForm(String[] aFields);

	// <start-adobe><start-thin>
	/** JS used to see if the forms need to be saved or not */
	public boolean getDirty();

	/** JS sets the flag that defines if the forms should be saved or not */
	public void setDirty(boolean dirty);

	// <end-thin><end-adobe>

	boolean hasFormsOnPage(int page);

	public PdfObject getFormResources();

	/** returns true the forms will be rasterized on the display instead of using the form widgets. */
	public boolean formsRasterizedForDisplay();

	public Object[] getCalculationOrder();

	public boolean isXFA();

	Node getXFA(int xfaTemplate);
}
